Request

Response

    Cost Management API Rate Limits

    The Cost Management service of BIM 360/Forma observes a set of rate limits to ensure that all clients get sufficient service and that runaway applications don’t consume excessive resources. You’ll find general information about rate limits in APS Rate Limits and Quotas.

    These rate limits apply to each of the Cost Management API’s endpoints. Note that these rate limits are not service guarantees. In the uncommon case where total service use is too high across all clients, the accepted request rate may drop until traffic subsides.

    Scope

    The Cost Management service applies a separate rate limit to each application, identified by the user ID in the access token, for each API endpoint. For example, an application cannot make more than 300 requests per minute to the GET containers/:containerId/cost-items/:costItemId endpoint.

    The application can, however, exceed 300 combined requests per minute if those requests go to separate endpoints and requests to each endpoint stay within that endpoint’s rate limit.

    Endpoint Rate Limits

    These rate limits apply to Cost Management API endpoints:

    MethodEndpointLimit (requests/minute)
    POST containers/:containerId/workflows/actions 150
    GET containers/:containerId/workflows/:associationType/:associationId/actions 150
    GET containers/:containerId/attachments 100
    POST containers/:containerId/attachments 50
    POST containers/:containerId/attachments:batch-create 30
    DELETE containers/:containerId/attachments/:attachmentId 30
    POST containers/:containerId/attachment-folders 30
    GET containers/:containerId/properties 150
    POST containers/:containerId/property-values:batch-update 300
    GET containers/:containerId/segment-values 200
    GET containers/:containerId/segments/:segmentId/values 300
    POST containers/:containerId/segments/:segmentId/values 500
    POST containers/:containerId/segments/:segmentId/values:import 30
    DELETE containers/:containerId/segments/:segmentId/values/:valueId 50
    PATCH containers/:containerId/segments/:segmentId/values/:valueId 120
    GET containers/:containerId/segments/:segmentId/values/:valueId 300
    GET containers/:containerId/templates/:templateId/segments 100
    POST containers/:containerId/templates/:templateId/segments 30
    DELETE containers/:containerId/templates/:templateId/segments/:segmentId 30
    PATCH containers/:containerId/templates/:templateId/segments/:segmentId 30
    GET containers/:containerId/templates/:templateId/segments/:segmentId 30
    GET containers/:containerId/templates 250
    GET containers/:containerId/budgets 300
    POST containers/:containerId/budgets 60
    POST containers/:containerId/budgets:import 30
    DELETE containers/:containerId/budgets/:budgetId 30
    PATCH containers/:containerId/budgets/:budgetId 150
    GET containers/:containerId/budgets/:budgetId 120
    POST containers/:containerId/budgets-contracts:link 40
    POST containers/:containerId/cost-items:attach 50
    POST containers/:containerId/cost-items:detach 30
    GET containers/:containerId/change-orders 30
    GET containers/:containerId/change-orders/:changeOrder 60
    POST containers/:containerId/change-orders/:changeOrder 60
    GET containers/:containerId/change-orders/:changeOrder/:id 150
    PATCH containers/:containerId/change-orders/:changeOrder/:id 100
    DELETE containers/:containerId/change-orders/:changeOrder/:id 60
    DELETE containers/:containerId/contracts/:contractId 30
    PATCH containers/:containerId/contracts/:contractId 50
    GET containers/:containerId/contracts/:contractId 150
    GET containers/:containerId/contracts 120
    POST containers/:containerId/contracts 60
    GET containers/:containerId/cost-items 60
    POST containers/:containerId/cost-items 60
    POST containers/:containerId/cost-items:batch-create 30
    GET containers/:containerId/cost-items/:costItemId 300
    PATCH containers/:containerId/cost-items/:costItemId 250
    DELETE containers/:containerId/cost-items/:costItemId 200
    GET containers/:containerId/documents 30
    GET containers/:containerId/expenses 50
    POST containers/:containerId/expenses 50
    DELETE containers/:containerId/expenses/:id 50
    PATCH containers/:containerId/expenses/:id 20
    GET containers/:containerId/expenses/:id 20
    GET containers/:containerId/expenses/:expenseId/items 50
    POST containers/:containerId/expenses/:expenseId/items 20
    DELETE containers/:containerId/expenses/:expenseId/items/:id 50
    PATCH containers/:containerId/expenses/:expenseId/items/:id 20
    GET containers/:containerId/expenses/:expenseId/items/:id 50
    GET containers/:containerId/main-contracts 120
    POST containers/:containerId/main-contracts 30
    GET containers/:containerId/main-contracts/:id 100
    PATCH containers/:containerId/main-contracts/:id 30
    DELETE containers/:containerId/main-contracts/:id 30
    GET containers/:containerId/main-contracts/:mainContractId/items 120
    POST containers/:containerId/main-contracts/:mainContractId/items 60
    GET containers/:containerId/main-contracts/:mainContractId/items/:id 120
    PATCH containers/:containerId/main-contracts/:mainContractId/items/:id 60
    DELETE containers/:containerId/main-contracts/:mainContractId/items/:id 30
    GET containers/:containerId/payments 300
    GET containers/:containerId/payments/:id 50
    GET containers/:containerId/payment-items 300
    GET containers/:containerId/schedule-of-values 400
    POST containers/:containerId/schedule-of-values 150
    GET containers/:containerId/schedule-of-values/:id 50
    PATCH containers/:containerId/schedule-of-values/:id 100
    DELETE containers/:containerId/schedule-of-values/:id 30
    GET containers/:containerId/cost-items/:costItemId/sub-cost-items 150
    POST containers/:containerId/cost-items/:costItemId/sub-cost-items 150
    POST containers/:containerId/cost-items/:costItemId/sub-cost-items:copy 50
    PATCH containers/:containerId/cost-items/:costItemId/sub-cost-items/:subCostItemsId 150
    DELETE containers/:containerId/cost-items/:costItemId/sub-cost-items/:subCostItemsId 150
    GET containers/:containerId/taxes 400
    GET containers/:containerId/time-sheets 100
    POST containers/:containerId/time-sheets 60
    GET containers/:containerId/time-sheets/:id 30
    PATCH containers/:containerId/time-sheets/:id 30
    DELETE containers/:containerId/time-sheets/:id 30
    GET containers/:containerId/performance-tracking-items 80
    POST containers/:containerId/performance-tracking-items 30
    GET containers/:containerId/performance-tracking-items/:id 30
    DELETE containers/:containerId/performance-tracking-items/:id 30
    GET containers/:containerId/performance-tracking-item-instances 30
    POST containers/:containerId/performance-tracking-item-instances 30
    GET containers/:containerId/performance-tracking-item-instances/:id 30
    PATCH containers/:containerId/performance-tracking-item-instances/:id 60
    DELETE containers/:containerId/performance-tracking-item-instances/:id 30
    GET containers/:containerId/workflows/action-histories 50

    Overall Rate Limit

    The Cost Management service’s overall rate limit is 5000 requests per minute across all applications and endpoints. Note that this rate is not a service guarantee. In the uncommon case where total service use is too high across all clients, the accepted request rate may drop until traffic subsides.

    Violation Notification

    If an application makes a Cost Management API request that exceeds any of these rate limits, the Cost Management service returns an HTTP 429 error (described in detail in APS Rate Limits and Quotas).

    Changing Limits

    APS Rate Limits and Quotas describes how to request rate limit changes for APS APIs.